Maintenance for the SANSTubeCalibration algorithm #38773
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rbauststfc
added
SANS
rbauststfc
force-pushed
the
35982_SANS_tube_calibration_maintenance
branch
from
05008ec to
9b79293
Compare
MialLewis
requested changes
Feb 10, 2025
| @@ -321,15 +320,15 @@ def PyExec(self): | |||
| self._log_tube_calibration_issues() | |||
| self._notify_tube_cvalue_status(cvalues) | |||
|
|
|||
| def _match_workspaces_to_strip_positions(self, ws_list): | |||
| def _match_workspaces_to_strip_positions(self, ws_list) -> dict[int, any]: | |||
There was a problem hiding this comment.
If you don't want to import MatrixWorkspace, perhaps for readability it would be good to use a stringized type hint?
Regardless, I think this should be Any, from from typing import Any. I think any here might be the built-in function: https://docs.python.org/3/library/functions.html#any
There was a problem hiding this comment.
Ah yes, thanks, I thought the any didn't seem quite right. I recall trying the stringized type hint at the time but can't recall now why I didn't go for it, will take another look.
rbauststfc
force-pushed
the
35982_SANS_tube_calibration_maintenance
branch
from
9b79293 to
256b0dc
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of work
Summary of work
Address some of the maintenance items on the linked issue for the SANS tube calibration algorithms.
Refs #35982.
Further detail of work
MatrixWorkspace, for example. Obviously I'm happy to change this if people prefer, though.FlatTopPeakfunction. I'm afraid this was a function that I didn't write so I have only been able to add very basic documentation, however this seems consistent with several of our fitting functions.To test:
All tests should pass. As this is just maintenance work, I don't think it needs a manual test.
This does not require release notes because there are no user facing changes.
Reviewer
Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.
Code Review
Functional Tests
Does everything look good? Mark the review as Approve. A member of
@mantidproject/gatekeeperswill take care of it.Gatekeeper
If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.